GetIndexedCollectionItemInfo

GetIndexedCollectionItemInfo
Header:	Collections.h		Carbon status:	Supported

Obtains information about a specific collection item given the item’s collection index.

OSErr GetIndexedCollectionItemInfo (
    Collection c, 
    SInt32 index, 
    CollectionTag *tag, 
    SInt32 *id, 
    SInt32 *itemSize, 
    SInt32 *attributes
);

c: A reference to the collection object containing the item you want to obtain information about. The behavior of this function is undefined if you do not provide a reference to a valid collection object.
index: The collection index associated with the item you want to obtain information about.
tag: A pointer to a collection tag. On return, the collection tag associated with the specified item. You may specify the constant dontWantTag for this parameter if you do not want to determine the specified item’s collection tag.
id: A pointer to an SInt32 value. On return, the collection ID associated with the specified item. You may specify the constant dontWantId for this parameter if you do not want to determine the specified item’s collection ID.
itemSize: A pointer to an SInt32 value. On return, this value indicates the size in bytes of the data associated with the specified item. You may specify the constant dontWantSize for this parameter if you do not want to determine the specified item’s data size.
attributes: A pointer to an SInt32 value. On return, this value contains a copy of the attributes associated with the specified item. You may specify the constant dontWantAttributes for this parameter if you do not want a copy of the item’s attributes.

function result: A result code.

DISCUSSION

To obtain information about a collection item using the collection tag and collection ID to specify the item, use the GetCollectionItemInfo function.

To obtain information about a collection item using the collection tag and tag list position to specify the item, use the GetTaggedCollectionItemInfo function.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.